Fix Doxygen @param and @tparam names that do not match the declarations by darkdi · Pull Request #23564 · NVIDIA/cudf

darkdi · 2026-08-06T08:12:26Z

Description

Doxygen tags in cpp/include and cpp/src that name something the declaration below them does not have. Comments only — no code, no behaviour, no tests.

@tparam with the name missing — column_view_base::head and mutable_column_view::head both carry @tparam The type to cast to, so Doxygen takes The as the template parameter name and T goes undocumented.

@tparam left over from a refactor — eight of the make_device_uvector* overloads in detail/utilities/vector_factories.hpp document both Container and T, but those overloads are template <typename Container> only. The T line is a leftover from the host_span<T> overloads above them.

@tparam renamed — id_to_type documents t while the parameter is Id; dictionary_column_wrapper documents SourceElementTo while the parameter is SourceElementT.

@param on a function that takes nothing — arrow_column::view() and arrow_table::view() document stream and mr, copied from the to_arrow overload directly above each. Both take no arguments.

@param where @tparam was meant — is_boolean() documents @param type The data_type to verify and is_nested() documents @param T; both are template <typename T> predicates with no runtime arguments.

A second commit covers the further files pointed out in review: column_device_view_base.cuh, type_dispatcher.hpp's IdTypeMap, iterator.cuh, timestamp_utilities.cuh, rolling/detail/range_utils.cuh and strings/count_matches.hpp.

Follows #21762 and #21764, which did the same for other entries in /include and /src. Every tag here was opened and read against the declaration underneath it.

Checklist

I am familiar with the Contributing Guidelines.
New or existing tests cover these changes. — comment-only, existing tests unaffected
The documentation is up to date with these changes.

copy-pr-bot · 2026-08-06T08:12:29Z

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

coderabbitai · 2026-08-06T08:13:48Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Summary by CodeRabbit

Documentation
- Corrected template parameter names and annotations across public API documentation.
- Clarified documentation for column views, vector factories, type traits, type dispatching, iterators, timestamp utilities, rolling operations, string matching, and dictionary column wrappers.
- Removed outdated parameter descriptions from Arrow conversion documentation.
- Updated copyright and attribution notices.
- No runtime behavior, function signatures, or API functionality changed.

Walkthrough

This change corrects Doxygen template parameter names and annotations across cuDF column, vector factory, utility, rolling, string, and test headers. It also updates selected SPDX notices. Function signatures and runtime behavior remain unchanged.

Changes

Doxygen documentation corrections

Layer / File(s)	Summary
Column view template documentation `cpp/include/cudf/column/column_view.hpp`, `cpp/include/cudf/column/column_device_view_base.cuh`	The `head()` documentation now names template parameter `T` for immutable and mutable column views.
Vector factory template documentation `cpp/include/cudf/detail/utilities/vector_factories.hpp`	Container-based overloads now document template parameter `Container` instead of `T`.
Utility and test template documentation `cpp/include/cudf/detail/iterator.cuh`, `cpp/include/cudf/utilities/traits.hpp`, `cpp/include/cudf/utilities/type_dispatcher.hpp`, `cpp/include/cudf_test/column_wrapper.hpp`, `cpp/include/cudf_test/timestamp_utilities.cuh`, `cpp/src/rolling/detail/range_utils.cuh`, `cpp/src/strings/count_matches.hpp`	Corrected Doxygen annotations and template parameter names. Updated selected SPDX notices.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

rapidsai/cudf#23125: Both PRs update Doxygen documentation in overlapping headers.
rapidsai/cudf#23581: The PRs both modify documentation in column_wrapper and generate_timestamps areas.

Suggested reviewers: vyasr, ttnghia

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the primary change: correcting mismatched Doxygen parameter names.
Description check	✅ Passed	The description directly explains the Doxygen documentation fixes and confirms that the changes are comment-only.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

_{Comment @coderabbitai help to get the list of available commands.}

darkdi · 2026-08-06T08:14:10Z

The Label Checker is red because I can't add labels from a fork — this needs doc and non-breaking from someone with write access. Everything else is green.

igorpeshansky

Three more include files with the same issues: cpp/include/cudf/column/column_device_view_base.cuh (#23564 (comment)), cpp/include/cudf/detail/iterator.cuh (#23564 (comment)), and cpp/include/cudf_test/timestamp_utilities.cuh (#23564 (comment)).

[Really optional] Also in cpp/src: cpp/src/rolling/detail/range_utils.cuh:570 and cpp/src/strings/count_matches.hpp:32.

igorpeshansky · 2026-08-06T08:48:39Z

 */
 bool is_bit_castable(data_type from, data_type to);

 template <typename From, typename To>


[Optional] Prior code, but undocumented… Seems like this PR is a good place to add a doc for cudf::is_convertible, but feel free to defer to a follow-up.

igorpeshansky · 2026-08-06T08:54:09Z

 *
 * @tparam KeyElementTo Specify a fixed-width type for the key values of the dictionary
- * @tparam SourceElementTo For converting fixed-width values to the KeyElementTo
+ * @tparam SourceElementT For converting fixed-width values to the KeyElementTo


Suggested change

* @tparam SourceElementT For converting fixed-width values to the KeyElementTo

* @tparam SourceElementT For converting fixed-width values to the `KeyElementTo`

[Optional] fixed_width_column_wrapper uses the following phrasing:

@tparam SourceElementT The fixed-width element type that is used to create elements of type `ElementTo`

Worth making them consistent (one way or another)?

Quick ping on the second (optional) half of that comment… Would love to hear your thoughts.

Sorry, that half slipped past me. Took the fixed_width_column_wrapper wording since the dictionary wrapper is doing the same job, so the two read the same way now.

- column_device_view_base.cuh: name the head<T>() template parameter - type_dispatcher.hpp: the parameter is IdTypeMap, id_to_type_impl is its default - iterator.cuh, range_utils.cuh, count_matches.hpp: name the template parameter - timestamp_utilities.cuh: Rep and Period are local aliases, the parameters are T and nullable - traits.hpp: the return descriptions refer to T, not to a data_type argument - column_wrapper.hpp: mark up KeyElementTo as code

igorpeshansky

LGTM

igorpeshansky · 2026-08-06T19:55:47Z

 *
 * @tparam KeyElementTo Specify a fixed-width type for the key values of the dictionary
- * @tparam SourceElementTo For converting fixed-width values to the KeyElementTo
+ * @tparam SourceElementT For converting fixed-width values to the KeyElementTo


Quick ping on the second (optional) half of that comment… Would love to hear your thoughts.

igorpeshansky · 2026-08-06T22:28:18Z

/ok to test e3abeb9

igorpeshansky · 2026-08-06T22:38:15Z

 * trying to return different types from the same function.
 *
- * @tparam id_to_type_impl Maps a `cudf::type_id` its dispatched C++ type
+ * @tparam IdTypeMap Maps a `cudf::type_id` its dispatched C++ type


[Optional] Just noticed a (prior) typo:

Suggested change

* @tparam IdTypeMap Maps a `cudf::type_id` its dispatched C++ type

* @tparam IdTypeMap Maps a `cudf::type_id` to its dispatched C++ type

Applied, the to was missing

ttnghia · 2026-08-07T15:37:48Z

/ok to test 59f1cc1

Signed-off-by: Igor Peshansky <ipeshansky@nvidia.com>

igorpeshansky · 2026-08-07T18:14:11Z

/ok to test a0110b6

igorpeshansky · 2026-08-08T02:31:10Z

/ok to test 940b078

…rapper

darkdi · 2026-08-10T07:52:02Z

Two commits since your approval, both from the optional comments: the SourceElementT wording and the IdTypeMap typo. Needs another ok to test when you get a chance. Leaving cudf::is_convertible out as you suggested, I will send the doc for it separately.

igorpeshansky · 2026-08-10T17:54:45Z

/ok to test 3e199ff

igorpeshansky · 2026-08-10T21:22:47Z

/ok to test 137cbe5

igorpeshansky · 2026-08-11T03:48:06Z

/ok to test 44441ff

igorpeshansky · 2026-08-11T07:44:38Z

/ok to test 0057962

PointKernel · 2026-08-11T17:33:07Z

/merge

Fix Doxygen @PARAM and @tparam names that do not match the declarations

45ed6f4

darkdi requested a review from a team as a code owner August 6, 2026 08:12

darkdi requested review from igorpeshansky and vyasr August 6, 2026 08:12

github-actions Bot assigned darkdi Aug 6, 2026

github-actions Bot added the libcudf Affects libcudf (C++/CUDA) code. label Aug 6, 2026

igorpeshansky added doc Documentation non-breaking Non-breaking change labels Aug 6, 2026

igorpeshansky reviewed Aug 6, 2026

View reviewed changes

igorpeshansky approved these changes Aug 6, 2026

View reviewed changes

Merge branch 'main' into fix/doxygen-param-names

e3abeb9

igorpeshansky reviewed Aug 6, 2026

View reviewed changes

github-actions Bot assigned igorpeshansky Aug 6, 2026

Merge branch 'main' into fix/doxygen-param-names

59f1cc1

github-actions Bot assigned ttnghia Aug 7, 2026

ttnghia unassigned ttnghia and igorpeshansky Aug 7, 2026

ttnghia approved these changes Aug 7, 2026

View reviewed changes

igorpeshansky and others added 2 commits August 7, 2026 14:05

Update copyrights.

f1138e6

Signed-off-by: Igor Peshansky <ipeshansky@nvidia.com>

Merge branch 'main' into fix/doxygen-param-names

a0110b6

github-actions Bot assigned igorpeshansky Aug 7, 2026

igorpeshansky removed their assignment Aug 7, 2026

Merge branch 'main' into fix/doxygen-param-names

940b078

github-actions Bot assigned igorpeshansky Aug 8, 2026

igorpeshansky removed their assignment Aug 8, 2026

darkdi added 2 commits August 10, 2026 10:50

Align the dictionary SourceElementT wording with fixed_width_column_w…

bb10c80

…rapper

Fix the IdTypeMap typo pointed out in review

c084842

Merge branch 'main' into fix/doxygen-param-names

3e199ff

github-actions Bot assigned igorpeshansky Aug 10, 2026

Merge branch 'main' into fix/doxygen-param-names

137cbe5

Merge branch 'main' into fix/doxygen-param-names

44441ff

Merge branch 'main' into fix/doxygen-param-names

0057962

PointKernel approved these changes Aug 11, 2026

View reviewed changes

PointKernel added the 5 - Ready to Merge Testing and reviews complete, ready to merge label Aug 11, 2026

rapids-bot Bot merged commit e9b1458 into NVIDIA:main Aug 12, 2026
394 of 399 checks passed

	* @tparam SourceElementT For converting fixed-width values to the KeyElementTo
	* @tparam SourceElementT For converting fixed-width values to the `KeyElementTo`

	* @tparam IdTypeMap Maps a `cudf::type_id` its dispatched C++ type
	* @tparam IdTypeMap Maps a `cudf::type_id` to its dispatched C++ type

Uh oh!

Conversation

darkdi commented Aug 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

copy-pr-bot Bot commented Aug 6, 2026

Uh oh!

coderabbitai Bot commented Aug 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Summary by CodeRabbit

Walkthrough

Changes

Uh oh!

darkdi commented Aug 6, 2026

Uh oh!

igorpeshansky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

igorpeshansky Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

igorpeshansky Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

igorpeshansky Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

darkdi Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

igorpeshansky left a comment

Choose a reason for hiding this comment

Uh oh!

igorpeshansky Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

igorpeshansky commented Aug 6, 2026

Uh oh!

igorpeshansky Aug 6, 2026

Choose a reason for hiding this comment

Uh oh!

darkdi Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

ttnghia commented Aug 7, 2026

Uh oh!

igorpeshansky commented Aug 7, 2026

Uh oh!

igorpeshansky commented Aug 8, 2026

Uh oh!

darkdi commented Aug 10, 2026

Uh oh!

igorpeshansky commented Aug 10, 2026

Uh oh!

igorpeshansky commented Aug 10, 2026

Uh oh!

igorpeshansky commented Aug 11, 2026

Uh oh!

igorpeshansky commented Aug 11, 2026

Uh oh!

PointKernel commented Aug 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

darkdi commented Aug 6, 2026 •

edited

Loading

coderabbitai Bot commented Aug 6, 2026 •

edited

Loading